3 * Copyright © 2006 Yuri Astrakhan "<Firstname><Lastname>@gmail.com"
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18 * http://www.gnu.org/copyleft/gpl.html
24 use MediaWiki\Logger\LoggerFactory
;
25 use MediaWiki\MediaWikiServices
;
26 use Wikimedia\Timestamp\TimestampException
;
29 * This is the main API class, used for both external and internal processing.
30 * When executed, it will create the requested formatter object,
31 * instantiate and execute an object associated with the needed action,
32 * and use formatter to print results.
33 * In case of an exception, an error message will be printed using the same formatter.
35 * To use API from another application, run it using FauxRequest object, in which
36 * case any internal exceptions will not be handled but passed up to the caller.
37 * After successful execution, use getResult() for the resulting data.
41 class ApiMain
extends ApiBase
{
43 * When no format parameter is given, this format will be used
45 const API_DEFAULT_FORMAT
= 'jsonfm';
48 * When no uselang parameter is given, this language will be used
50 const API_DEFAULT_USELANG
= 'user';
53 * List of available modules: action name => module class
55 private static $Modules = [
56 'login' => ApiLogin
::class,
57 'clientlogin' => ApiClientLogin
::class,
58 'logout' => ApiLogout
::class,
59 'createaccount' => ApiAMCreateAccount
::class,
60 'linkaccount' => ApiLinkAccount
::class,
61 'unlinkaccount' => ApiRemoveAuthenticationData
::class,
62 'changeauthenticationdata' => ApiChangeAuthenticationData
::class,
63 'removeauthenticationdata' => ApiRemoveAuthenticationData
::class,
64 'resetpassword' => ApiResetPassword
::class,
65 'query' => ApiQuery
::class,
66 'expandtemplates' => ApiExpandTemplates
::class,
67 'parse' => ApiParse
::class,
68 'stashedit' => ApiStashEdit
::class,
69 'opensearch' => ApiOpenSearch
::class,
70 'feedcontributions' => ApiFeedContributions
::class,
71 'feedrecentchanges' => ApiFeedRecentChanges
::class,
72 'feedwatchlist' => ApiFeedWatchlist
::class,
73 'help' => ApiHelp
::class,
74 'paraminfo' => ApiParamInfo
::class,
75 'rsd' => ApiRsd
::class,
76 'compare' => ApiComparePages
::class,
77 'tokens' => ApiTokens
::class,
78 'checktoken' => ApiCheckToken
::class,
79 'cspreport' => ApiCSPReport
::class,
80 'validatepassword' => ApiValidatePassword
::class,
83 'purge' => ApiPurge
::class,
84 'setnotificationtimestamp' => ApiSetNotificationTimestamp
::class,
85 'rollback' => ApiRollback
::class,
86 'delete' => ApiDelete
::class,
87 'undelete' => ApiUndelete
::class,
88 'protect' => ApiProtect
::class,
89 'block' => ApiBlock
::class,
90 'unblock' => ApiUnblock
::class,
91 'move' => ApiMove
::class,
92 'edit' => ApiEditPage
::class,
93 'upload' => ApiUpload
::class,
94 'filerevert' => ApiFileRevert
::class,
95 'emailuser' => ApiEmailUser
::class,
96 'watch' => ApiWatch
::class,
97 'patrol' => ApiPatrol
::class,
98 'import' => ApiImport
::class,
99 'clearhasmsg' => ApiClearHasMsg
::class,
100 'userrights' => ApiUserrights
::class,
101 'options' => ApiOptions
::class,
102 'imagerotate' => ApiImageRotate
::class,
103 'revisiondelete' => ApiRevisionDelete
::class,
104 'managetags' => ApiManageTags
::class,
105 'tag' => ApiTag
::class,
106 'mergehistory' => ApiMergeHistory
::class,
107 'setpagelanguage' => ApiSetPageLanguage
::class,
111 * List of available formats: format name => format class
113 private static $Formats = [
114 'json' => ApiFormatJson
::class,
115 'jsonfm' => ApiFormatJson
::class,
116 'php' => ApiFormatPhp
::class,
117 'phpfm' => ApiFormatPhp
::class,
118 'xml' => ApiFormatXml
::class,
119 'xmlfm' => ApiFormatXml
::class,
120 'rawfm' => ApiFormatJson
::class,
121 'none' => ApiFormatNone
::class,
125 * List of user roles that are specifically relevant to the API.
126 * [ 'right' => [ 'msg' => 'Some message with a $1',
127 * 'params' => [ $someVarToSubst ] ],
130 private static $mRights = [
132 'msg' => 'right-writeapi',
136 'msg' => 'api-help-right-apihighlimits',
137 'params' => [ ApiBase
::LIMIT_SML2
, ApiBase
::LIMIT_BIG2
]
146 private $mModuleMgr, $mResult, $mErrorFormatter = null;
147 /** @var ApiContinuationManager|null */
148 private $mContinuationManager;
150 private $mEnableWrite;
151 private $mInternalMode, $mSquidMaxage;
155 private $mCacheMode = 'private';
156 private $mCacheControl = [];
157 private $mParamsUsed = [];
158 private $mParamsSensitive = [];
160 /** @var bool|null Cached return value from self::lacksSameOriginSecurity() */
161 private $lacksSameOriginSecurity = null;
164 * Constructs an instance of ApiMain that utilizes the module and format specified by $request.
166 * @param IContextSource|WebRequest|null $context If this is an instance of
167 * FauxRequest, errors are thrown and no printing occurs
168 * @param bool $enableWrite Should be set to true if the api may modify data
170 public function __construct( $context = null, $enableWrite = false ) {
171 if ( $context === null ) {
172 $context = RequestContext
::getMain();
173 } elseif ( $context instanceof WebRequest
) {
176 $context = RequestContext
::getMain();
178 // We set a derivative context so we can change stuff later
179 $this->setContext( new DerivativeContext( $context ) );
181 if ( isset( $request ) ) {
182 $this->getContext()->setRequest( $request );
184 $request = $this->getRequest();
187 $this->mInternalMode
= ( $request instanceof FauxRequest
);
189 // Special handling for the main module: $parent === $this
190 parent
::__construct( $this, $this->mInternalMode ?
'main_int' : 'main' );
192 $config = $this->getConfig();
194 if ( !$this->mInternalMode
) {
195 // Log if a request with a non-whitelisted Origin header is seen
196 // with session cookies.
197 $originHeader = $request->getHeader( 'Origin' );
198 if ( $originHeader === false ) {
201 $originHeader = trim( $originHeader );
202 $origins = preg_split( '/\s+/', $originHeader );
204 $sessionCookies = array_intersect(
205 array_keys( $_COOKIE ),
206 MediaWiki\Session\SessionManager
::singleton()->getVaryCookies()
208 if ( $origins && $sessionCookies && (
209 count( $origins ) !== 1 ||
!self
::matchOrigin(
211 $config->get( 'CrossSiteAJAXdomains' ),
212 $config->get( 'CrossSiteAJAXdomainExceptions' )
215 LoggerFactory
::getInstance( 'cors' )->warning(
216 'Non-whitelisted CORS request with session cookies', [
217 'origin' => $originHeader,
218 'cookies' => $sessionCookies,
219 'ip' => $request->getIP(),
220 'userAgent' => $this->getUserAgent(),
221 'wiki' => wfWikiID(),
226 // If we're in a mode that breaks the same-origin policy, strip
227 // user credentials for security.
228 if ( $this->lacksSameOriginSecurity() ) {
230 wfDebug( "API: stripping user credentials when the same-origin policy is not applied\n" );
231 $wgUser = new User();
232 $this->getContext()->setUser( $wgUser );
233 $request->response()->header( 'MediaWiki-Login-Suppressed: true' );
237 $this->mResult
= new ApiResult( $this->getConfig()->get( 'APIMaxResultSize' ) );
239 // Setup uselang. This doesn't use $this->getParameter()
240 // because we're not ready to handle errors yet.
241 $uselang = $request->getVal( 'uselang', self
::API_DEFAULT_USELANG
);
242 if ( $uselang === 'user' ) {
243 // Assume the parent context is going to return the user language
244 // for uselang=user (see T85635).
246 if ( $uselang === 'content' ) {
247 $uselang = MediaWikiServices
::getInstance()->getContentLanguage()->getCode();
249 $code = RequestContext
::sanitizeLangCode( $uselang );
250 $this->getContext()->setLanguage( $code );
251 if ( !$this->mInternalMode
) {
253 $wgLang = $this->getContext()->getLanguage();
254 RequestContext
::getMain()->setLanguage( $wgLang );
258 // Set up the error formatter. This doesn't use $this->getParameter()
259 // because we're not ready to handle errors yet.
260 $errorFormat = $request->getVal( 'errorformat', 'bc' );
261 $errorLangCode = $request->getVal( 'errorlang', 'uselang' );
262 $errorsUseDB = $request->getCheck( 'errorsuselocal' );
263 if ( in_array( $errorFormat, [ 'plaintext', 'wikitext', 'html', 'raw', 'none' ], true ) ) {
264 if ( $errorLangCode === 'uselang' ) {
265 $errorLang = $this->getLanguage();
266 } elseif ( $errorLangCode === 'content' ) {
267 $errorLang = MediaWikiServices
::getInstance()->getContentLanguage();
269 $errorLangCode = RequestContext
::sanitizeLangCode( $errorLangCode );
270 $errorLang = Language
::factory( $errorLangCode );
272 $this->mErrorFormatter
= new ApiErrorFormatter(
273 $this->mResult
, $errorLang, $errorFormat, $errorsUseDB
276 $this->mErrorFormatter
= new ApiErrorFormatter_BackCompat( $this->mResult
);
278 $this->mResult
->setErrorFormatter( $this->getErrorFormatter() );
280 $this->mModuleMgr
= new ApiModuleManager( $this );
281 $this->mModuleMgr
->addModules( self
::$Modules, 'action' );
282 $this->mModuleMgr
->addModules( $config->get( 'APIModules' ), 'action' );
283 $this->mModuleMgr
->addModules( self
::$Formats, 'format' );
284 $this->mModuleMgr
->addModules( $config->get( 'APIFormatModules' ), 'format' );
286 Hooks
::run( 'ApiMain::moduleManager', [ $this->mModuleMgr
] );
288 $this->mContinuationManager
= null;
289 $this->mEnableWrite
= $enableWrite;
291 $this->mSquidMaxage
= -1; // flag for executeActionWithErrorHandling()
292 $this->mCommit
= false;
296 * Return true if the API was started by other PHP code using FauxRequest
299 public function isInternalMode() {
300 return $this->mInternalMode
;
304 * Get the ApiResult object associated with current request
308 public function getResult() {
309 return $this->mResult
;
313 * Get the security flag for the current request
316 public function lacksSameOriginSecurity() {
317 if ( $this->lacksSameOriginSecurity
!== null ) {
318 return $this->lacksSameOriginSecurity
;
321 $request = $this->getRequest();
324 if ( $request->getVal( 'callback' ) !== null ) {
325 $this->lacksSameOriginSecurity
= true;
330 if ( $request->getVal( 'origin' ) === '*' ) {
331 $this->lacksSameOriginSecurity
= true;
335 // Header to be used from XMLHTTPRequest when the request might
336 // otherwise be used for XSS.
337 if ( $request->getHeader( 'Treat-as-Untrusted' ) !== false ) {
338 $this->lacksSameOriginSecurity
= true;
342 // Allow extensions to override.
343 $this->lacksSameOriginSecurity
= !Hooks
::run( 'RequestHasSameOriginSecurity', [ $request ] );
344 return $this->lacksSameOriginSecurity
;
348 * Get the ApiErrorFormatter object associated with current request
349 * @return ApiErrorFormatter
351 public function getErrorFormatter() {
352 return $this->mErrorFormatter
;
356 * Get the continuation manager
357 * @return ApiContinuationManager|null
359 public function getContinuationManager() {
360 return $this->mContinuationManager
;
364 * Set the continuation manager
365 * @param ApiContinuationManager|null $manager
367 public function setContinuationManager( ApiContinuationManager
$manager = null ) {
368 if ( $manager !== null && $this->mContinuationManager
!== null ) {
369 throw new UnexpectedValueException(
370 __METHOD__
. ': tried to set manager from ' . $manager->getSource() .
371 ' when a manager is already set from ' . $this->mContinuationManager
->getSource()
374 $this->mContinuationManager
= $manager;
378 * Get the API module object. Only works after executeAction()
382 public function getModule() {
383 return $this->mModule
;
387 * Get the result formatter object. Only works after setupExecuteAction()
389 * @return ApiFormatBase
391 public function getPrinter() {
392 return $this->mPrinter
;
396 * Set how long the response should be cached.
400 public function setCacheMaxAge( $maxage ) {
401 $this->setCacheControl( [
402 'max-age' => $maxage,
403 's-maxage' => $maxage
408 * Set the type of caching headers which will be sent.
410 * @param string $mode One of:
411 * - 'public': Cache this object in public caches, if the maxage or smaxage
412 * parameter is set, or if setCacheMaxAge() was called. If a maximum age is
413 * not provided by any of these means, the object will be private.
414 * - 'private': Cache this object only in private client-side caches.
415 * - 'anon-public-user-private': Make this object cacheable for logged-out
416 * users, but private for logged-in users. IMPORTANT: If this is set, it must be
417 * set consistently for a given URL, it cannot be set differently depending on
418 * things like the contents of the database, or whether the user is logged in.
420 * If the wiki does not allow anonymous users to read it, the mode set here
421 * will be ignored, and private caching headers will always be sent. In other words,
422 * the "public" mode is equivalent to saying that the data sent is as public as a page
425 * For user-dependent data, the private mode should generally be used. The
426 * anon-public-user-private mode should only be used where there is a particularly
427 * good performance reason for caching the anonymous response, but where the
428 * response to logged-in users may differ, or may contain private data.
430 * If this function is never called, then the default will be the private mode.
432 public function setCacheMode( $mode ) {
433 if ( !in_array( $mode, [ 'private', 'public', 'anon-public-user-private' ] ) ) {
434 wfDebug( __METHOD__
. ": unrecognised cache mode \"$mode\"\n" );
436 // Ignore for forwards-compatibility
440 if ( !User
::isEveryoneAllowed( 'read' ) ) {
441 // Private wiki, only private headers
442 if ( $mode !== 'private' ) {
443 wfDebug( __METHOD__
. ": ignoring request for $mode cache mode, private wiki\n" );
449 if ( $mode === 'public' && $this->getParameter( 'uselang' ) === 'user' ) {
450 // User language is used for i18n, so we don't want to publicly
451 // cache. Anons are ok, because if they have non-default language
452 // then there's an appropriate Vary header set by whatever set
453 // their non-default language.
454 wfDebug( __METHOD__
. ": downgrading cache mode 'public' to " .
455 "'anon-public-user-private' due to uselang=user\n" );
456 $mode = 'anon-public-user-private';
459 wfDebug( __METHOD__
. ": setting cache mode $mode\n" );
460 $this->mCacheMode
= $mode;
464 * Set directives (key/value pairs) for the Cache-Control header.
465 * Boolean values will be formatted as such, by including or omitting
466 * without an equals sign.
468 * Cache control values set here will only be used if the cache mode is not
469 * private, see setCacheMode().
471 * @param array $directives
473 public function setCacheControl( $directives ) {
474 $this->mCacheControl
= $directives +
$this->mCacheControl
;
478 * Create an instance of an output formatter by its name
480 * @param string $format
482 * @return ApiFormatBase
484 public function createPrinterByName( $format ) {
485 $printer = $this->mModuleMgr
->getModule( $format, 'format', /* $ignoreCache */ true );
486 if ( $printer === null ) {
488 [ 'apierror-unknownformat', wfEscapeWikiText( $format ) ], 'unknown_format'
496 * Execute api request. Any errors will be handled if the API was called by the remote client.
498 public function execute() {
499 if ( $this->mInternalMode
) {
500 $this->executeAction();
502 $this->executeActionWithErrorHandling();
507 * Execute an action, and in case of an error, erase whatever partial results
508 * have been accumulated, and replace it with an error message and a help screen.
510 protected function executeActionWithErrorHandling() {
511 // Verify the CORS header before executing the action
512 if ( !$this->handleCORS() ) {
513 // handleCORS() has sent a 403, abort
517 // Exit here if the request method was OPTIONS
518 // (assume there will be a followup GET or POST)
519 if ( $this->getRequest()->getMethod() === 'OPTIONS' ) {
523 // In case an error occurs during data output,
524 // clear the output buffer and print just the error information
525 $obLevel = ob_get_level();
528 $t = microtime( true );
531 $this->executeAction();
532 $runTime = microtime( true ) - $t;
533 $this->logRequest( $runTime );
534 MediaWikiServices
::getInstance()->getStatsdDataFactory()->timing(
535 'api.' . $this->mModule
->getModuleName() . '.executeTiming', 1000 * $runTime
537 } catch ( Exception
$e ) { // @todo Remove this block when HHVM is no longer supported
538 $this->handleException( $e );
539 $this->logRequest( microtime( true ) - $t, $e );
541 } catch ( Throwable
$e ) {
542 $this->handleException( $e );
543 $this->logRequest( microtime( true ) - $t, $e );
547 // Commit DBs and send any related cookies and headers
548 MediaWiki
::preOutputCommit( $this->getContext() );
550 // Send cache headers after any code which might generate an error, to
551 // avoid sending public cache headers for errors.
552 $this->sendCacheHeaders( $isError );
554 // Executing the action might have already messed with the output
556 while ( ob_get_level() > $obLevel ) {
562 * Handle an exception as an API response
565 * @param Exception|Throwable $e
567 protected function handleException( $e ) {
568 // T65145: Rollback any open database transactions
569 if ( !$e instanceof ApiUsageException
) {
570 // ApiUsageExceptions are intentional, so don't rollback if that's the case
571 MWExceptionHandler
::rollbackMasterChangesAndLog( $e );
574 // Allow extra cleanup and logging
575 Hooks
::run( 'ApiMain::onException', [ $this, $e ] );
577 // Handle any kind of exception by outputting properly formatted error message.
578 // If this fails, an unhandled exception should be thrown so that global error
579 // handler will process and log it.
581 $errCodes = $this->substituteResultWithError( $e );
583 // Error results should not be cached
584 $this->setCacheMode( 'private' );
586 $response = $this->getRequest()->response();
587 $headerStr = 'MediaWiki-API-Error: ' . implode( ', ', $errCodes );
588 $response->header( $headerStr );
590 // Reset and print just the error message
593 // Printer may not be initialized if the extractRequestParams() fails for the main module
594 $this->createErrorPrinter();
598 $this->printResult( $e->getCode() );
599 } catch ( ApiUsageException
$ex ) {
600 // The error printer itself is failing. Try suppressing its request
601 // parameters and redo.
603 $this->addWarning( 'apiwarn-errorprinterfailed' );
604 foreach ( $ex->getStatusValue()->getErrors() as $error ) {
606 $this->mPrinter
->addWarning( $error );
607 } catch ( Exception
$ex2 ) { // @todo Remove this block when HHVM is no longer supported
609 $this->addWarning( $error );
610 } catch ( Throwable
$ex2 ) {
612 $this->addWarning( $error );
617 $this->mPrinter
= null;
618 $this->createErrorPrinter();
619 $this->mPrinter
->forceDefaultParams();
620 if ( $e->getCode() ) {
621 $response->statusHeader( 200 ); // Reset in case the fallback doesn't want a non-200
623 $this->printResult( $e->getCode() );
628 * Handle an exception from the ApiBeforeMain hook.
630 * This tries to print the exception as an API response, to be more
631 * friendly to clients. If it fails, it will rethrow the exception.
634 * @param Exception|Throwable $e
635 * @throws Exception|Throwable
637 public static function handleApiBeforeMainException( $e ) {
641 $main = new self( RequestContext
::getMain(), false );
642 $main->handleException( $e );
643 $main->logRequest( 0, $e );
644 } catch ( Exception
$e2 ) { // @todo Remove this block when HHVM is no longer supported
645 // Nope, even that didn't work. Punt.
647 } catch ( Throwable
$e2 ) {
648 // Nope, even that didn't work. Punt.
652 // Reset cache headers
653 $main->sendCacheHeaders( true );
659 * Check the &origin= query parameter against the Origin: HTTP header and respond appropriately.
661 * If no origin parameter is present, nothing happens.
662 * If an origin parameter is present but doesn't match the Origin header, a 403 status code
663 * is set and false is returned.
664 * If the parameter and the header do match, the header is checked against $wgCrossSiteAJAXdomains
665 * and $wgCrossSiteAJAXdomainExceptions, and if the origin qualifies, the appropriate CORS
667 * https://www.w3.org/TR/cors/#resource-requests
668 * https://www.w3.org/TR/cors/#resource-preflight-requests
670 * @return bool False if the caller should abort (403 case), true otherwise (all other cases)
672 protected function handleCORS() {
673 $originParam = $this->getParameter( 'origin' ); // defaults to null
674 if ( $originParam === null ) {
675 // No origin parameter, nothing to do
679 $request = $this->getRequest();
680 $response = $request->response();
682 $matchedOrigin = false;
683 $allowTiming = false;
686 if ( $originParam === '*' ) {
687 // Request for anonymous CORS
688 // Technically we should check for the presence of an Origin header
689 // and not process it as CORS if it's not set, but that would
690 // require us to vary on Origin for all 'origin=*' requests which
691 // we don't want to do.
692 $matchedOrigin = true;
694 $allowCredentials = 'false';
695 $varyOrigin = false; // No need to vary
697 // Non-anonymous CORS, check we allow the domain
699 // Origin: header is a space-separated list of origins, check all of them
700 $originHeader = $request->getHeader( 'Origin' );
701 if ( $originHeader === false ) {
704 $originHeader = trim( $originHeader );
705 $origins = preg_split( '/\s+/', $originHeader );
708 if ( !in_array( $originParam, $origins ) ) {
709 // origin parameter set but incorrect
710 // Send a 403 response
711 $response->statusHeader( 403 );
712 $response->header( 'Cache-Control: no-cache' );
713 echo "'origin' parameter does not match Origin header\n";
718 $config = $this->getConfig();
719 $matchedOrigin = count( $origins ) === 1 && self
::matchOrigin(
721 $config->get( 'CrossSiteAJAXdomains' ),
722 $config->get( 'CrossSiteAJAXdomainExceptions' )
725 $allowOrigin = $originHeader;
726 $allowCredentials = 'true';
727 $allowTiming = $originHeader;
730 if ( $matchedOrigin ) {
731 $requestedMethod = $request->getHeader( 'Access-Control-Request-Method' );
732 $preflight = $request->getMethod() === 'OPTIONS' && $requestedMethod !== false;
734 // This is a CORS preflight request
735 if ( $requestedMethod !== 'POST' && $requestedMethod !== 'GET' ) {
736 // If method is not a case-sensitive match, do not set any additional headers and terminate.
737 $response->header( 'MediaWiki-CORS-Rejection: Unsupported method requested in preflight' );
740 // We allow the actual request to send the following headers
741 $requestedHeaders = $request->getHeader( 'Access-Control-Request-Headers' );
742 if ( $requestedHeaders !== false ) {
743 if ( !self
::matchRequestedHeaders( $requestedHeaders ) ) {
744 $response->header( 'MediaWiki-CORS-Rejection: Unsupported header requested in preflight' );
747 $response->header( 'Access-Control-Allow-Headers: ' . $requestedHeaders );
750 // We only allow the actual request to be GET or POST
751 $response->header( 'Access-Control-Allow-Methods: POST, GET' );
752 } elseif ( $request->getMethod() !== 'POST' && $request->getMethod() !== 'GET' ) {
753 // Unsupported non-preflight method, don't handle it as CORS
755 'MediaWiki-CORS-Rejection: Unsupported method for simple request or actual request'
760 $response->header( "Access-Control-Allow-Origin: $allowOrigin" );
761 $response->header( "Access-Control-Allow-Credentials: $allowCredentials" );
762 // https://www.w3.org/TR/resource-timing/#timing-allow-origin
763 if ( $allowTiming !== false ) {
764 $response->header( "Timing-Allow-Origin: $allowTiming" );
769 'Access-Control-Expose-Headers: MediaWiki-API-Error, Retry-After, X-Database-Lag, '
770 . 'MediaWiki-Login-Suppressed'
774 $response->header( 'MediaWiki-CORS-Rejection: Origin mismatch' );
778 $this->getOutput()->addVaryHeader( 'Origin' );
785 * Attempt to match an Origin header against a set of rules and a set of exceptions
786 * @param string $value Origin header
787 * @param array $rules Set of wildcard rules
788 * @param array $exceptions Set of wildcard rules
789 * @return bool True if $value matches a rule in $rules and doesn't match
790 * any rules in $exceptions, false otherwise
792 protected static function matchOrigin( $value, $rules, $exceptions ) {
793 foreach ( $rules as $rule ) {
794 if ( preg_match( self
::wildcardToRegex( $rule ), $value ) ) {
795 // Rule matches, check exceptions
796 foreach ( $exceptions as $exc ) {
797 if ( preg_match( self
::wildcardToRegex( $exc ), $value ) ) {
810 * Attempt to validate the value of Access-Control-Request-Headers against a list
811 * of headers that we allow the follow up request to send.
813 * @param string $requestedHeaders Comma separated list of HTTP headers
814 * @return bool True if all requested headers are in the list of allowed headers
816 protected static function matchRequestedHeaders( $requestedHeaders ) {
817 if ( trim( $requestedHeaders ) === '' ) {
820 $requestedHeaders = explode( ',', $requestedHeaders );
821 $allowedAuthorHeaders = array_flip( [
822 /* simple headers (see spec) */
827 /* non-authorable headers in XHR, which are however requested by some UAs */
831 /* MediaWiki whitelist */
835 foreach ( $requestedHeaders as $rHeader ) {
836 $rHeader = strtolower( trim( $rHeader ) );
837 if ( !isset( $allowedAuthorHeaders[$rHeader] ) ) {
838 LoggerFactory
::getInstance( 'api-warning' )->warning(
839 'CORS preflight failed on requested header: {header}', [
850 * Helper function to convert wildcard string into a regex
854 * @param string $wildcard String with wildcards
855 * @return string Regular expression
857 protected static function wildcardToRegex( $wildcard ) {
858 $wildcard = preg_quote( $wildcard, '/' );
859 $wildcard = str_replace(
865 return "/^https?:\/\/$wildcard$/";
869 * Send caching headers
870 * @param bool $isError Whether an error response is being output
871 * @since 1.26 added $isError parameter
873 protected function sendCacheHeaders( $isError ) {
874 $response = $this->getRequest()->response();
875 $out = $this->getOutput();
877 $out->addVaryHeader( 'Treat-as-Untrusted' );
879 $config = $this->getConfig();
881 if ( $config->get( 'VaryOnXFP' ) ) {
882 $out->addVaryHeader( 'X-Forwarded-Proto' );
885 if ( !$isError && $this->mModule
&&
886 ( $this->getRequest()->getMethod() === 'GET' ||
$this->getRequest()->getMethod() === 'HEAD' )
888 $etag = $this->mModule
->getConditionalRequestData( 'etag' );
889 if ( $etag !== null ) {
890 $response->header( "ETag: $etag" );
892 $lastMod = $this->mModule
->getConditionalRequestData( 'last-modified' );
893 if ( $lastMod !== null ) {
894 $response->header( 'Last-Modified: ' . wfTimestamp( TS_RFC2822
, $lastMod ) );
898 // The logic should be:
899 // $this->mCacheControl['max-age'] is set?
900 // Use it, the module knows better than our guess.
901 // !$this->mModule || $this->mModule->isWriteMode(), and mCacheMode is private?
902 // Use 0 because we can guess caching is probably the wrong thing to do.
903 // Use $this->getParameter( 'maxage' ), which already defaults to 0.
905 if ( isset( $this->mCacheControl
['max-age'] ) ) {
906 $maxage = $this->mCacheControl
['max-age'];
907 } elseif ( ( $this->mModule
&& !$this->mModule
->isWriteMode() ) ||
908 $this->mCacheMode
!== 'private'
910 $maxage = $this->getParameter( 'maxage' );
912 $privateCache = 'private, must-revalidate, max-age=' . $maxage;
914 if ( $this->mCacheMode
== 'private' ) {
915 $response->header( "Cache-Control: $privateCache" );
919 $useKeyHeader = $config->get( 'UseKeyHeader' );
920 if ( $this->mCacheMode
== 'anon-public-user-private' ) {
921 $out->addVaryHeader( 'Cookie' );
922 $response->header( $out->getVaryHeader() );
923 if ( $useKeyHeader ) {
924 $response->header( $out->getKeyHeader() );
925 if ( $out->haveCacheVaryCookies() ) {
926 // Logged in, mark this request private
927 $response->header( "Cache-Control: $privateCache" );
930 // Logged out, send normal public headers below
931 } elseif ( MediaWiki\Session\SessionManager
::getGlobalSession()->isPersistent() ) {
932 // Logged in or otherwise has session (e.g. anonymous users who have edited)
933 // Mark request private
934 $response->header( "Cache-Control: $privateCache" );
937 } // else no Key and anonymous, send public headers below
940 // Send public headers
941 $response->header( $out->getVaryHeader() );
942 if ( $useKeyHeader ) {
943 $response->header( $out->getKeyHeader() );
946 // If nobody called setCacheMaxAge(), use the (s)maxage parameters
947 if ( !isset( $this->mCacheControl
['s-maxage'] ) ) {
948 $this->mCacheControl
['s-maxage'] = $this->getParameter( 'smaxage' );
950 if ( !isset( $this->mCacheControl
['max-age'] ) ) {
951 $this->mCacheControl
['max-age'] = $this->getParameter( 'maxage' );
954 if ( !$this->mCacheControl
['s-maxage'] && !$this->mCacheControl
['max-age'] ) {
955 // Public cache not requested
956 // Sending a Vary header in this case is harmless, and protects us
957 // against conditional calls of setCacheMaxAge().
958 $response->header( "Cache-Control: $privateCache" );
963 $this->mCacheControl
['public'] = true;
965 // Send an Expires header
966 $maxAge = min( $this->mCacheControl
['s-maxage'], $this->mCacheControl
['max-age'] );
967 $expiryUnixTime = ( $maxAge == 0 ?
1 : time() +
$maxAge );
968 $response->header( 'Expires: ' . wfTimestamp( TS_RFC2822
, $expiryUnixTime ) );
970 // Construct the Cache-Control header
973 foreach ( $this->mCacheControl
as $name => $value ) {
974 if ( is_bool( $value ) ) {
976 $ccHeader .= $separator . $name;
980 $ccHeader .= $separator . "$name=$value";
985 $response->header( "Cache-Control: $ccHeader" );
989 * Create the printer for error output
991 private function createErrorPrinter() {
992 if ( !isset( $this->mPrinter
) ) {
993 $value = $this->getRequest()->getVal( 'format', self
::API_DEFAULT_FORMAT
);
994 if ( !$this->mModuleMgr
->isDefined( $value, 'format' ) ) {
995 $value = self
::API_DEFAULT_FORMAT
;
997 $this->mPrinter
= $this->createPrinterByName( $value );
1000 // Printer may not be able to handle errors. This is particularly
1001 // likely if the module returns something for getCustomPrinter().
1002 if ( !$this->mPrinter
->canPrintErrors() ) {
1003 $this->mPrinter
= $this->createPrinterByName( self
::API_DEFAULT_FORMAT
);
1008 * Create an error message for the given exception.
1010 * If an ApiUsageException, errors/warnings will be extracted from the
1011 * embedded StatusValue.
1013 * Any other exception will be returned with a generic code and wrapper
1014 * text around the exception's (presumably English) message as a single
1015 * error (no warnings).
1017 * @param Exception|Throwable $e
1018 * @param string $type 'error' or 'warning'
1019 * @return ApiMessage[]
1022 protected function errorMessagesFromException( $e, $type = 'error' ) {
1024 if ( $e instanceof ApiUsageException
) {
1025 foreach ( $e->getStatusValue()->getErrorsByType( $type ) as $error ) {
1026 $messages[] = ApiMessage
::create( $error );
1028 } elseif ( $type !== 'error' ) {
1029 // None of the rest have any messages for non-error types
1031 // Something is seriously wrong
1032 $config = $this->getConfig();
1033 // TODO: Avoid embedding arbitrary class names in the error code.
1034 $class = preg_replace( '#^Wikimedia\\\Rdbms\\\#', '', get_class( $e ) );
1035 $code = 'internal_api_error_' . $class;
1036 $data = [ 'errorclass' => get_class( $e ) ];
1037 if ( $config->get( 'ShowExceptionDetails' ) ) {
1038 if ( $e instanceof ILocalizedException
) {
1039 $msg = $e->getMessageObject();
1040 } elseif ( $e instanceof MessageSpecifier
) {
1041 $msg = Message
::newFromSpecifier( $e );
1043 $msg = wfEscapeWikiText( $e->getMessage() );
1045 $params = [ 'apierror-exceptioncaught', WebRequest
::getRequestId(), $msg ];
1047 $params = [ 'apierror-exceptioncaughttype', WebRequest
::getRequestId(), get_class( $e ) ];
1050 $messages[] = ApiMessage
::create( $params, $code, $data );
1056 * Replace the result data with the information about an exception.
1057 * @param Exception|Throwable $e
1058 * @return string[] Error codes
1060 protected function substituteResultWithError( $e ) {
1061 $result = $this->getResult();
1062 $formatter = $this->getErrorFormatter();
1063 $config = $this->getConfig();
1066 // Remember existing warnings and errors across the reset
1067 $errors = $result->getResultData( [ 'errors' ] );
1068 $warnings = $result->getResultData( [ 'warnings' ] );
1070 if ( $warnings !== null ) {
1071 $result->addValue( null, 'warnings', $warnings, ApiResult
::NO_SIZE_CHECK
);
1073 if ( $errors !== null ) {
1074 $result->addValue( null, 'errors', $errors, ApiResult
::NO_SIZE_CHECK
);
1076 // Collect the copied error codes for the return value
1077 foreach ( $errors as $error ) {
1078 if ( isset( $error['code'] ) ) {
1079 $errorCodes[$error['code']] = true;
1084 // Add errors from the exception
1085 $modulePath = $e instanceof ApiUsageException ?
$e->getModulePath() : null;
1086 foreach ( $this->errorMessagesFromException( $e, 'error' ) as $msg ) {
1087 if ( ApiErrorFormatter
::isValidApiCode( $msg->getApiCode() ) ) {
1088 $errorCodes[$msg->getApiCode()] = true;
1090 LoggerFactory
::getInstance( 'api-warning' )->error( 'Invalid API error code "{code}"', [
1091 'code' => $msg->getApiCode(),
1094 $errorCodes['<invalid-code>'] = true;
1096 $formatter->addError( $modulePath, $msg );
1098 foreach ( $this->errorMessagesFromException( $e, 'warning' ) as $msg ) {
1099 $formatter->addWarning( $modulePath, $msg );
1102 // Add additional data. Path depends on whether we're in BC mode or not.
1103 // Data depends on the type of exception.
1104 if ( $formatter instanceof ApiErrorFormatter_BackCompat
) {
1105 $path = [ 'error' ];
1109 if ( $e instanceof ApiUsageException
) {
1110 $link = wfExpandUrl( wfScript( 'api' ) );
1111 $result->addContentValue(
1115 $this->msg( 'api-usage-docref', $link )->inLanguage( $formatter->getLanguage() )->text()
1117 . $this->msg( 'api-usage-mailinglist-ref' )->inLanguage( $formatter->getLanguage() )->text()
1121 if ( $config->get( 'ShowExceptionDetails' ) ) {
1122 $result->addContentValue(
1125 $this->msg( 'api-exception-trace',
1129 MWExceptionHandler
::getRedactedTraceAsString( $e )
1130 )->inLanguage( $formatter->getLanguage() )->text()
1135 // Add the id and such
1136 $this->addRequestedFields( [ 'servedby' ] );
1138 return array_keys( $errorCodes );
1142 * Add requested fields to the result
1143 * @param string[] $force Which fields to force even if not requested. Accepted values are:
1146 protected function addRequestedFields( $force = [] ) {
1147 $result = $this->getResult();
1149 $requestid = $this->getParameter( 'requestid' );
1150 if ( $requestid !== null ) {
1151 $result->addValue( null, 'requestid', $requestid, ApiResult
::NO_SIZE_CHECK
);
1154 if ( $this->getConfig()->get( 'ShowHostnames' ) && (
1155 in_array( 'servedby', $force, true ) ||
$this->getParameter( 'servedby' )
1157 $result->addValue( null, 'servedby', wfHostname(), ApiResult
::NO_SIZE_CHECK
);
1160 if ( $this->getParameter( 'curtimestamp' ) ) {
1161 $result->addValue( null, 'curtimestamp', wfTimestamp( TS_ISO_8601
, time() ),
1162 ApiResult
::NO_SIZE_CHECK
);
1165 if ( $this->getParameter( 'responselanginfo' ) ) {
1166 $result->addValue( null, 'uselang', $this->getLanguage()->getCode(),
1167 ApiResult
::NO_SIZE_CHECK
);
1168 $result->addValue( null, 'errorlang', $this->getErrorFormatter()->getLanguage()->getCode(),
1169 ApiResult
::NO_SIZE_CHECK
);
1174 * Set up for the execution.
1177 protected function setupExecuteAction() {
1178 $this->addRequestedFields();
1180 $params = $this->extractRequestParams();
1181 $this->mAction
= $params['action'];
1187 * Set up the module for response
1188 * @return ApiBase The module that will handle this action
1189 * @throws MWException
1190 * @throws ApiUsageException
1192 protected function setupModule() {
1193 // Instantiate the module requested by the user
1194 $module = $this->mModuleMgr
->getModule( $this->mAction
, 'action' );
1195 if ( $module === null ) {
1196 // Probably can't happen
1197 // @codeCoverageIgnoreStart
1198 $this->dieWithError(
1199 [ 'apierror-unknownaction', wfEscapeWikiText( $this->mAction
) ], 'unknown_action'
1201 // @codeCoverageIgnoreEnd
1203 $moduleParams = $module->extractRequestParams();
1205 // Check token, if necessary
1206 if ( $module->needsToken() === true ) {
1207 throw new MWException(
1208 "Module '{$module->getModuleName()}' must be updated for the new token handling. " .
1209 'See documentation for ApiBase::needsToken for details.'
1212 if ( $module->needsToken() ) {
1213 if ( !$module->mustBePosted() ) {
1214 throw new MWException(
1215 "Module '{$module->getModuleName()}' must require POST to use tokens."
1219 if ( !isset( $moduleParams['token'] ) ) {
1220 // Probably can't happen
1221 // @codeCoverageIgnoreStart
1222 $module->dieWithError( [ 'apierror-missingparam', 'token' ] );
1223 // @codeCoverageIgnoreEnd
1226 $module->requirePostedParameters( [ 'token' ] );
1228 if ( !$module->validateToken( $moduleParams['token'], $moduleParams ) ) {
1229 $module->dieWithError( 'apierror-badtoken' );
1239 private function getMaxLag() {
1240 $dbLag = MediaWikiServices
::getInstance()->getDBLoadBalancer()->getMaxLag();
1242 'host' => $dbLag[0],
1247 $jobQueueLagFactor = $this->getConfig()->get( 'JobQueueIncludeInMaxLagFactor' );
1248 if ( $jobQueueLagFactor ) {
1249 // Turn total number of jobs into seconds by using the configured value
1250 $totalJobs = array_sum( JobQueueGroup
::singleton()->getQueueSizes() );
1251 $jobQueueLag = $totalJobs / (float)$jobQueueLagFactor;
1252 if ( $jobQueueLag > $lagInfo['lag'] ) {
1254 'host' => wfHostname(), // XXX: Is there a better value that could be used?
1255 'lag' => $jobQueueLag,
1256 'type' => 'jobqueue',
1257 'jobs' => $totalJobs,
1262 Hooks
::runWithoutAbort( 'ApiMaxLagInfo', [ &$lagInfo ] );
1268 * Check the max lag if necessary
1269 * @param ApiBase $module Api module being used
1270 * @param array $params Array an array containing the request parameters.
1271 * @return bool True on success, false should exit immediately
1273 protected function checkMaxLag( $module, $params ) {
1274 if ( $module->shouldCheckMaxlag() && isset( $params['maxlag'] ) ) {
1275 $maxLag = $params['maxlag'];
1276 $lagInfo = $this->getMaxLag();
1277 if ( $lagInfo['lag'] > $maxLag ) {
1278 $response = $this->getRequest()->response();
1280 $response->header( 'Retry-After: ' . max( (int)$maxLag, 5 ) );
1281 $response->header( 'X-Database-Lag: ' . (int)$lagInfo['lag'] );
1283 if ( $this->getConfig()->get( 'ShowHostnames' ) ) {
1284 $this->dieWithError(
1285 [ 'apierror-maxlag', $lagInfo['lag'], $lagInfo['host'] ],
1291 $this->dieWithError( [ 'apierror-maxlag-generic', $lagInfo['lag'] ], 'maxlag', $lagInfo );
1299 * Check selected RFC 7232 precondition headers
1301 * RFC 7232 envisions a particular model where you send your request to "a
1302 * resource", and for write requests that you can read "the resource" by
1303 * changing the method to GET. When the API receives a GET request, it
1304 * works out even though "the resource" from RFC 7232's perspective might
1305 * be many resources from MediaWiki's perspective. But it totally fails for
1306 * a POST, since what HTTP sees as "the resource" is probably just
1307 * "/api.php" with all the interesting bits in the body.
1309 * Therefore, we only support RFC 7232 precondition headers for GET (and
1310 * HEAD). That means we don't need to bother with If-Match and
1311 * If-Unmodified-Since since they only apply to modification requests.
1313 * And since we don't support Range, If-Range is ignored too.
1316 * @param ApiBase $module Api module being used
1317 * @return bool True on success, false should exit immediately
1319 protected function checkConditionalRequestHeaders( $module ) {
1320 if ( $this->mInternalMode
) {
1321 // No headers to check in internal mode
1325 if ( $this->getRequest()->getMethod() !== 'GET' && $this->getRequest()->getMethod() !== 'HEAD' ) {
1326 // Don't check POSTs
1332 $ifNoneMatch = array_diff(
1333 $this->getRequest()->getHeader( 'If-None-Match', WebRequest
::GETHEADER_LIST
) ?
: [],
1336 if ( $ifNoneMatch ) {
1337 if ( $ifNoneMatch === [ '*' ] ) {
1338 // API responses always "exist"
1341 $etag = $module->getConditionalRequestData( 'etag' );
1344 if ( $ifNoneMatch && $etag !== null ) {
1345 $test = substr( $etag, 0, 2 ) === 'W/' ?
substr( $etag, 2 ) : $etag;
1346 $match = array_map( function ( $s ) {
1347 return substr( $s, 0, 2 ) === 'W/' ?
substr( $s, 2 ) : $s;
1349 $return304 = in_array( $test, $match, true );
1351 $value = trim( $this->getRequest()->getHeader( 'If-Modified-Since' ) );
1353 // Some old browsers sends sizes after the date, like this:
1354 // Wed, 20 Aug 2003 06:51:19 GMT; length=5202
1356 $i = strpos( $value, ';' );
1357 if ( $i !== false ) {
1358 $value = trim( substr( $value, 0, $i ) );
1361 if ( $value !== '' ) {
1363 $ts = new MWTimestamp( $value );
1365 // RFC 7231 IMF-fixdate
1366 $ts->getTimestamp( TS_RFC2822
) === $value ||
1368 $ts->format( 'l, d-M-y H:i:s' ) . ' GMT' === $value ||
1369 // asctime (with and without space-padded day)
1370 $ts->format( 'D M j H:i:s Y' ) === $value ||
1371 $ts->format( 'D M j H:i:s Y' ) === $value
1373 $lastMod = $module->getConditionalRequestData( 'last-modified' );
1374 if ( $lastMod !== null ) {
1375 // Mix in some MediaWiki modification times
1378 'user' => $this->getUser()->getTouched(),
1379 'epoch' => $this->getConfig()->get( 'CacheEpoch' ),
1381 if ( $this->getConfig()->get( 'UseSquid' ) ) {
1382 // T46570: the core page itself may not change, but resources might
1383 $modifiedTimes['sepoch'] = wfTimestamp(
1384 TS_MW
, time() - $this->getConfig()->get( 'SquidMaxage' )
1387 Hooks
::run( 'OutputPageCheckLastModified', [ &$modifiedTimes, $this->getOutput() ] );
1388 $lastMod = max( $modifiedTimes );
1389 $return304 = wfTimestamp( TS_MW
, $lastMod ) <= $ts->getTimestamp( TS_MW
);
1392 } catch ( TimestampException
$e ) {
1393 // Invalid timestamp, ignore it
1399 $this->getRequest()->response()->statusHeader( 304 );
1401 // Avoid outputting the compressed representation of a zero-length body
1402 Wikimedia\
suppressWarnings();
1403 ini_set( 'zlib.output_compression', 0 );
1404 Wikimedia\restoreWarnings
();
1405 wfClearOutputBuffers();
1414 * Check for sufficient permissions to execute
1415 * @param ApiBase $module An Api module
1417 protected function checkExecutePermissions( $module ) {
1418 $user = $this->getUser();
1419 if ( $module->isReadMode() && !User
::isEveryoneAllowed( 'read' ) &&
1420 !$user->isAllowed( 'read' )
1422 $this->dieWithError( 'apierror-readapidenied' );
1425 if ( $module->isWriteMode() ) {
1426 if ( !$this->mEnableWrite
) {
1427 $this->dieWithError( 'apierror-noapiwrite' );
1428 } elseif ( !$user->isAllowed( 'writeapi' ) ) {
1429 $this->dieWithError( 'apierror-writeapidenied' );
1430 } elseif ( $this->getRequest()->getHeader( 'Promise-Non-Write-API-Action' ) ) {
1431 $this->dieWithError( 'apierror-promised-nonwrite-api' );
1434 $this->checkReadOnly( $module );
1437 // Allow extensions to stop execution for arbitrary reasons.
1438 $message = 'hookaborted';
1439 if ( !Hooks
::run( 'ApiCheckCanExecute', [ $module, $user, &$message ] ) ) {
1440 $this->dieWithError( $message );
1445 * Check if the DB is read-only for this user
1446 * @param ApiBase $module An Api module
1448 protected function checkReadOnly( $module ) {
1449 if ( wfReadOnly() ) {
1450 $this->dieReadOnly();
1453 if ( $module->isWriteMode()
1454 && $this->getUser()->isBot()
1455 && MediaWikiServices
::getInstance()->getDBLoadBalancer()->getServerCount() > 1
1457 $this->checkBotReadOnly();
1462 * Check whether we are readonly for bots
1464 private function checkBotReadOnly() {
1465 // Figure out how many servers have passed the lag threshold
1467 $lagLimit = $this->getConfig()->get( 'APIMaxLagThreshold' );
1468 $laggedServers = [];
1469 $loadBalancer = MediaWikiServices
::getInstance()->getDBLoadBalancer();
1470 foreach ( $loadBalancer->getLagTimes() as $serverIndex => $lag ) {
1471 if ( $lag > $lagLimit ) {
1473 $laggedServers[] = $loadBalancer->getServerName( $serverIndex ) . " ({$lag}s)";
1477 // If a majority of replica DBs are too lagged then disallow writes
1478 $replicaCount = $loadBalancer->getServerCount() - 1;
1479 if ( $numLagged >= ceil( $replicaCount / 2 ) ) {
1480 $laggedServers = implode( ', ', $laggedServers );
1482 'api-readonly', // Deprecate this channel in favor of api-warning?
1483 "Api request failed as read only because the following DBs are lagged: $laggedServers"
1485 LoggerFactory
::getInstance( 'api-warning' )->warning(
1486 "Api request failed as read only because the following DBs are lagged: {laggeddbs}", [
1487 'laggeddbs' => $laggedServers,
1491 $this->dieWithError(
1494 [ 'readonlyreason' => "Waiting for $numLagged lagged database(s)" ]
1500 * Check asserts of the user's rights
1501 * @param array $params
1503 protected function checkAsserts( $params ) {
1504 if ( isset( $params['assert'] ) ) {
1505 $user = $this->getUser();
1506 switch ( $params['assert'] ) {
1508 if ( $user->isAnon() ) {
1509 $this->dieWithError( 'apierror-assertuserfailed' );
1513 if ( !$user->isAllowed( 'bot' ) ) {
1514 $this->dieWithError( 'apierror-assertbotfailed' );
1519 if ( isset( $params['assertuser'] ) ) {
1520 $assertUser = User
::newFromName( $params['assertuser'], false );
1521 if ( !$assertUser ||
!$this->getUser()->equals( $assertUser ) ) {
1522 $this->dieWithError(
1523 [ 'apierror-assertnameduserfailed', wfEscapeWikiText( $params['assertuser'] ) ]
1530 * Check POST for external response and setup result printer
1531 * @param ApiBase $module An Api module
1532 * @param array $params An array with the request parameters
1534 protected function setupExternalResponse( $module, $params ) {
1535 $validMethods = [ 'GET', 'HEAD', 'POST', 'OPTIONS' ];
1536 $request = $this->getRequest();
1538 if ( !in_array( $request->getMethod(), $validMethods ) ) {
1539 $this->dieWithError( 'apierror-invalidmethod', null, null, 405 );
1542 if ( !$request->wasPosted() && $module->mustBePosted() ) {
1543 // Module requires POST. GET request might still be allowed
1544 // if $wgDebugApi is true, otherwise fail.
1545 $this->dieWithErrorOrDebug( [ 'apierror-mustbeposted', $this->mAction
] );
1548 // See if custom printer is used
1549 $this->mPrinter
= $module->getCustomPrinter();
1550 if ( is_null( $this->mPrinter
) ) {
1551 // Create an appropriate printer
1552 $this->mPrinter
= $this->createPrinterByName( $params['format'] );
1555 if ( $request->getProtocol() === 'http' && (
1556 $request->getSession()->shouldForceHTTPS() ||
1557 ( $this->getUser()->isLoggedIn() &&
1558 $this->getUser()->requiresHTTPS() )
1560 $this->addDeprecation( 'apiwarn-deprecation-httpsexpected', 'https-expected' );
1565 * Execute the actual module, without any error handling
1567 protected function executeAction() {
1568 $params = $this->setupExecuteAction();
1570 // Check asserts early so e.g. errors in parsing a module's parameters due to being
1571 // logged out don't override the client's intended "am I logged in?" check.
1572 $this->checkAsserts( $params );
1574 $module = $this->setupModule();
1575 $this->mModule
= $module;
1577 if ( !$this->mInternalMode
) {
1578 $this->setRequestExpectations( $module );
1581 $this->checkExecutePermissions( $module );
1583 if ( !$this->checkMaxLag( $module, $params ) ) {
1587 if ( !$this->checkConditionalRequestHeaders( $module ) ) {
1591 if ( !$this->mInternalMode
) {
1592 $this->setupExternalResponse( $module, $params );
1596 Hooks
::run( 'APIAfterExecute', [ &$module ] );
1598 $this->reportUnusedParams();
1600 if ( !$this->mInternalMode
) {
1601 MWDebug
::appendDebugInfoToApiResult( $this->getContext(), $this->getResult() );
1603 $this->printResult();
1608 * Set database connection, query, and write expectations given this module request
1609 * @param ApiBase $module
1611 protected function setRequestExpectations( ApiBase
$module ) {
1612 $limits = $this->getConfig()->get( 'TrxProfilerLimits' );
1613 $trxProfiler = Profiler
::instance()->getTransactionProfiler();
1614 $trxProfiler->setLogger( LoggerFactory
::getInstance( 'DBPerformance' ) );
1615 if ( $this->getRequest()->hasSafeMethod() ) {
1616 $trxProfiler->setExpectations( $limits['GET'], __METHOD__
);
1617 } elseif ( $this->getRequest()->wasPosted() && !$module->isWriteMode() ) {
1618 $trxProfiler->setExpectations( $limits['POST-nonwrite'], __METHOD__
);
1619 $this->getRequest()->markAsSafeRequest();
1621 $trxProfiler->setExpectations( $limits['POST'], __METHOD__
);
1626 * Log the preceding request
1627 * @param float $time Time in seconds
1628 * @param Exception|Throwable|null $e Exception caught while processing the request
1630 protected function logRequest( $time, $e = null ) {
1631 $request = $this->getRequest();
1634 'ip' => $request->getIP(),
1635 'userAgent' => $this->getUserAgent(),
1636 'wiki' => wfWikiID(),
1637 'timeSpentBackend' => (int)round( $time * 1000 ),
1638 'hadError' => $e !== null,
1644 '$schema' => '/mediawiki/api/request/0.0.1',
1646 'id' => UIDGenerator
::newUUIDv1(),
1647 'dt' => gmdate( 'c' ),
1648 'domain' => $this->getConfig()->get( 'ServerName' ),
1649 'stream' => 'mediawiki.api-request'
1652 'method' => $request->getMethod(),
1653 'client_ip' => $request->getIP(),
1654 'request_headers' => []
1656 'database' => wfWikiID(),
1657 'backend_time_ms' => (int)round( $time * 1000 ),
1661 // If set, these headers will be logged in http.request_headers.
1662 // A http.request_headers entry should not be set if the header was not provided.
1663 if ( $request->getHeader( 'User-agent' ) ) {
1664 $logCtx['http']['request_headers']['user-agent'] = $request->getHeader( 'User-agent' );
1666 if ( $request->getHeader( 'Api-user-agent' ) ) {
1667 $logCtx['http']['request_headers']['api-user-agent'] = $request->getHeader( 'Api-user-agent' );
1670 $logCtx['meta']['request_id'] =
1671 $logCtx['http']['request_headers']['x-request-id'] = WebRequest
::getRequestId();
1674 $logCtx['api_error_codes'] = [];
1675 foreach ( $this->errorMessagesFromException( $e ) as $msg ) {
1676 $legacyLogCtx['errorCodes'][] = $msg->getApiCode();
1677 $logCtx['api_error_codes'][] = $msg->getApiCode();
1681 // Construct space separated message for 'api' log channel
1682 $msg = "API {$request->getMethod()} " .
1683 wfUrlencode( str_replace( ' ', '_', $this->getUser()->getName() ) ) .
1684 " {$legacyLogCtx['ip']} " .
1685 "T={$legacyLogCtx['timeSpentBackend']}ms";
1687 $sensitive = array_flip( $this->getSensitiveParams() );
1688 foreach ( $this->getParamsUsed() as $name ) {
1689 $value = $request->getVal( $name );
1690 if ( $value === null ) {
1694 if ( isset( $sensitive[$name] ) ) {
1695 $value = '[redacted]';
1696 $encValue = '[redacted]';
1697 } elseif ( strlen( $value ) > 256 ) {
1698 $value = substr( $value, 0, 256 );
1699 $encValue = $this->encodeRequestLogValue( $value ) . '[...]';
1701 $encValue = $this->encodeRequestLogValue( $value );
1704 $legacyLogCtx['params'][$name] = $value;
1705 $logCtx['params'][$name] = $value;
1706 $msg .= " {$name}={$encValue}";
1709 wfDebugLog( 'api', $msg, 'private' );
1710 // ApiAction channel is for structured data consumers.
1711 // The ApiAction was using logging channel is deprecated and is replaced
1712 // by the api-request channel.
1713 wfDebugLog( 'ApiAction', '', 'private', $legacyLogCtx );
1714 wfDebugLog( 'api-request', '', 'private', $logCtx );
1718 * Encode a value in a format suitable for a space-separated log line.
1722 protected function encodeRequestLogValue( $s ) {
1725 $chars = ';@$!*(),/:';
1726 $numChars = strlen( $chars );
1727 for ( $i = 0; $i < $numChars; $i++
) {
1728 $table[rawurlencode( $chars[$i] )] = $chars[$i];
1732 return strtr( rawurlencode( $s ), $table );
1736 * Get the request parameters used in the course of the preceding execute() request
1739 protected function getParamsUsed() {
1740 return array_keys( $this->mParamsUsed
);
1744 * Mark parameters as used
1745 * @param string|string[] $params
1747 public function markParamsUsed( $params ) {
1748 $this->mParamsUsed +
= array_fill_keys( (array)$params, true );
1752 * Get the request parameters that should be considered sensitive
1756 protected function getSensitiveParams() {
1757 return array_keys( $this->mParamsSensitive
);
1761 * Mark parameters as sensitive
1763 * @param string|string[] $params
1765 public function markParamsSensitive( $params ) {
1766 $this->mParamsSensitive +
= array_fill_keys( (array)$params, true );
1770 * Get a request value, and register the fact that it was used, for logging.
1771 * @param string $name
1772 * @param string|null $default
1773 * @return string|null
1775 public function getVal( $name, $default = null ) {
1776 $this->mParamsUsed
[$name] = true;
1778 $ret = $this->getRequest()->getVal( $name );
1779 if ( $ret === null ) {
1780 if ( $this->getRequest()->getArray( $name ) !== null ) {
1781 // See T12262 for why we don't just implode( '|', ... ) the
1783 $this->addWarning( [ 'apiwarn-unsupportedarray', $name ] );
1791 * Get a boolean request value, and register the fact that the parameter
1792 * was used, for logging.
1793 * @param string $name
1796 public function getCheck( $name ) {
1797 return $this->getVal( $name, null ) !== null;
1801 * Get a request upload, and register the fact that it was used, for logging.
1804 * @param string $name Parameter name
1805 * @return WebRequestUpload
1807 public function getUpload( $name ) {
1808 $this->mParamsUsed
[$name] = true;
1810 return $this->getRequest()->getUpload( $name );
1814 * Report unused parameters, so the client gets a hint in case it gave us parameters we don't know,
1815 * for example in case of spelling mistakes or a missing 'g' prefix for generators.
1817 protected function reportUnusedParams() {
1818 $paramsUsed = $this->getParamsUsed();
1819 $allParams = $this->getRequest()->getValueNames();
1821 if ( !$this->mInternalMode
) {
1822 // Printer has not yet executed; don't warn that its parameters are unused
1823 $printerParams = $this->mPrinter
->encodeParamName(
1824 array_keys( $this->mPrinter
->getFinalParams() ?
: [] )
1826 $unusedParams = array_diff( $allParams, $paramsUsed, $printerParams );
1828 $unusedParams = array_diff( $allParams, $paramsUsed );
1831 if ( count( $unusedParams ) ) {
1832 $this->addWarning( [
1833 'apierror-unrecognizedparams',
1834 Message
::listParam( array_map( 'wfEscapeWikiText', $unusedParams ), 'comma' ),
1835 count( $unusedParams )
1841 * Print results using the current printer
1843 * @param int $httpCode HTTP status code, or 0 to not change
1845 protected function printResult( $httpCode = 0 ) {
1846 if ( $this->getConfig()->get( 'DebugAPI' ) !== false ) {
1847 $this->addWarning( 'apiwarn-wgDebugAPI' );
1850 $printer = $this->mPrinter
;
1851 $printer->initPrinter( false );
1853 $printer->setHttpStatus( $httpCode );
1855 $printer->execute();
1856 $printer->closePrinter();
1862 public function isReadMode() {
1867 * See ApiBase for description.
1871 public function getAllowedParams() {
1874 ApiBase
::PARAM_DFLT
=> 'help',
1875 ApiBase
::PARAM_TYPE
=> 'submodule',
1878 ApiBase
::PARAM_DFLT
=> self
::API_DEFAULT_FORMAT
,
1879 ApiBase
::PARAM_TYPE
=> 'submodule',
1882 ApiBase
::PARAM_TYPE
=> 'integer'
1885 ApiBase
::PARAM_TYPE
=> 'integer',
1886 ApiBase
::PARAM_DFLT
=> 0
1889 ApiBase
::PARAM_TYPE
=> 'integer',
1890 ApiBase
::PARAM_DFLT
=> 0
1893 ApiBase
::PARAM_TYPE
=> [ 'user', 'bot' ]
1896 ApiBase
::PARAM_TYPE
=> 'user',
1898 'requestid' => null,
1899 'servedby' => false,
1900 'curtimestamp' => false,
1901 'responselanginfo' => false,
1904 ApiBase
::PARAM_DFLT
=> self
::API_DEFAULT_USELANG
,
1907 ApiBase
::PARAM_TYPE
=> [ 'plaintext', 'wikitext', 'html', 'raw', 'none', 'bc' ],
1908 ApiBase
::PARAM_DFLT
=> 'bc',
1911 ApiBase
::PARAM_DFLT
=> 'uselang',
1913 'errorsuselocal' => [
1914 ApiBase
::PARAM_DFLT
=> false,
1920 protected function getExamplesMessages() {
1923 => 'apihelp-help-example-main',
1924 'action=help&recursivesubmodules=1'
1925 => 'apihelp-help-example-recursive',
1929 public function modifyHelp( array &$help, array $options, array &$tocData ) {
1930 // Wish PHP had an "array_insert_before". Instead, we have to manually
1931 // reindex the array to get 'permissions' in the right place.
1934 foreach ( $oldHelp as $k => $v ) {
1935 if ( $k === 'submodules' ) {
1936 $help['permissions'] = '';
1940 $help['datatypes'] = '';
1941 $help['templatedparams'] = '';
1942 $help['credits'] = '';
1944 // Fill 'permissions'
1945 $help['permissions'] .= Html
::openElement( 'div',
1946 [ 'class' => 'apihelp-block apihelp-permissions' ] );
1947 $m = $this->msg( 'api-help-permissions' );
1948 if ( !$m->isDisabled() ) {
1949 $help['permissions'] .= Html
::rawElement( 'div', [ 'class' => 'apihelp-block-head' ],
1950 $m->numParams( count( self
::$mRights ) )->parse()
1953 $help['permissions'] .= Html
::openElement( 'dl' );
1954 foreach ( self
::$mRights as $right => $rightMsg ) {
1955 $help['permissions'] .= Html
::element( 'dt', null, $right );
1957 $rightMsg = $this->msg( $rightMsg['msg'], $rightMsg['params'] )->parse();
1958 $help['permissions'] .= Html
::rawElement( 'dd', null, $rightMsg );
1960 $groups = array_map( function ( $group ) {
1961 return $group == '*' ?
'all' : $group;
1962 }, User
::getGroupsWithPermission( $right ) );
1964 $help['permissions'] .= Html
::rawElement( 'dd', null,
1965 $this->msg( 'api-help-permissions-granted-to' )
1966 ->numParams( count( $groups ) )
1967 ->params( Message
::listParam( $groups ) )
1971 $help['permissions'] .= Html
::closeElement( 'dl' );
1972 $help['permissions'] .= Html
::closeElement( 'div' );
1974 // Fill 'datatypes', 'templatedparams', and 'credits', if applicable
1975 if ( empty( $options['nolead'] ) ) {
1976 $level = $options['headerlevel'];
1977 $tocnumber = &$options['tocnumber'];
1979 $header = $this->msg( 'api-help-datatypes-header' )->parse();
1981 $id = Sanitizer
::escapeIdForAttribute( 'main/datatypes', Sanitizer
::ID_PRIMARY
);
1982 $idFallback = Sanitizer
::escapeIdForAttribute( 'main/datatypes', Sanitizer
::ID_FALLBACK
);
1983 $headline = Linker
::makeHeadline( min( 6, $level ),
1984 ' class="apihelp-header">',
1990 // Ensure we have a sane anchor
1991 if ( $id !== 'main/datatypes' && $idFallback !== 'main/datatypes' ) {
1992 $headline = '<div id="main/datatypes"></div>' . $headline;
1994 $help['datatypes'] .= $headline;
1995 $help['datatypes'] .= $this->msg( 'api-help-datatypes' )->parseAsBlock();
1996 if ( !isset( $tocData['main/datatypes'] ) ) {
1997 $tocnumber[$level]++
;
1998 $tocData['main/datatypes'] = [
1999 'toclevel' => count( $tocnumber ),
2001 'anchor' => 'main/datatypes',
2003 'number' => implode( '.', $tocnumber ),
2008 $header = $this->msg( 'api-help-templatedparams-header' )->parse();
2010 $id = Sanitizer
::escapeIdForAttribute( 'main/templatedparams', Sanitizer
::ID_PRIMARY
);
2011 $idFallback = Sanitizer
::escapeIdForAttribute( 'main/templatedparams', Sanitizer
::ID_FALLBACK
);
2012 $headline = Linker
::makeHeadline( min( 6, $level ),
2013 ' class="apihelp-header">',
2019 // Ensure we have a sane anchor
2020 if ( $id !== 'main/templatedparams' && $idFallback !== 'main/templatedparams' ) {
2021 $headline = '<div id="main/templatedparams"></div>' . $headline;
2023 $help['templatedparams'] .= $headline;
2024 $help['templatedparams'] .= $this->msg( 'api-help-templatedparams' )->parseAsBlock();
2025 if ( !isset( $tocData['main/templatedparams'] ) ) {
2026 $tocnumber[$level]++
;
2027 $tocData['main/templatedparams'] = [
2028 'toclevel' => count( $tocnumber ),
2030 'anchor' => 'main/templatedparams',
2032 'number' => implode( '.', $tocnumber ),
2037 $header = $this->msg( 'api-credits-header' )->parse();
2038 $id = Sanitizer
::escapeIdForAttribute( 'main/credits', Sanitizer
::ID_PRIMARY
);
2039 $idFallback = Sanitizer
::escapeIdForAttribute( 'main/credits', Sanitizer
::ID_FALLBACK
);
2040 $headline = Linker
::makeHeadline( min( 6, $level ),
2041 ' class="apihelp-header">',
2047 // Ensure we have a sane anchor
2048 if ( $id !== 'main/credits' && $idFallback !== 'main/credits' ) {
2049 $headline = '<div id="main/credits"></div>' . $headline;
2051 $help['credits'] .= $headline;
2052 $help['credits'] .= $this->msg( 'api-credits' )->useDatabase( false )->parseAsBlock();
2053 if ( !isset( $tocData['main/credits'] ) ) {
2054 $tocnumber[$level]++
;
2055 $tocData['main/credits'] = [
2056 'toclevel' => count( $tocnumber ),
2058 'anchor' => 'main/credits',
2060 'number' => implode( '.', $tocnumber ),
2067 private $mCanApiHighLimits = null;
2070 * Check whether the current user is allowed to use high limits
2073 public function canApiHighLimits() {
2074 if ( !isset( $this->mCanApiHighLimits
) ) {
2075 $this->mCanApiHighLimits
= $this->getUser()->isAllowed( 'apihighlimits' );
2078 return $this->mCanApiHighLimits
;
2082 * Overrides to return this instance's module manager.
2083 * @return ApiModuleManager
2085 public function getModuleManager() {
2086 return $this->mModuleMgr
;
2090 * Fetches the user agent used for this request
2092 * The value will be the combination of the 'Api-User-Agent' header (if
2093 * any) and the standard User-Agent header (if any).
2097 public function getUserAgent() {
2099 $this->getRequest()->getHeader( 'Api-user-agent' ) . ' ' .
2100 $this->getRequest()->getHeader( 'User-agent' )
2106 * For really cool vim folding this needs to be at the end:
2107 * vim: foldmarker=@{,@} foldmethod=marker